================================================================
==                                                            ==
==                      POI Scourge Mod                       ==
==                                                            ==
================================================================
Thank you for downloading POI Scourge! This mod overhauls the looting and rewarding experience of clearing Points of Interest (POIs) in 7 Days to Die.

Instead of relying solely on RNG loot containers, you are now rewarded with "Scourge Tokens" for fully clearing a location of zombies. These tokens can be exchanged for valuable items, resources, and even vehicles.

--- TABLE OF CONTENTS ---
1. Installation
2. Core Features
   - Clearing & Rewards
   - Scourge Tokens
   - Infestation Beacons
3. The Exchange Station
4. Configuration (Settings.xml)
   - Economy Balancing
   - Visual Customization
5. Console Commands

--- 1. INSTALLATION ---
1. Navigate to your 7 Days to Die installation folder.
2. If it does not already exist, create a folder named 'Mods' (case-sensitive).
3. Place the entire 'POIScourge' folder (the one containing this readme) inside the Mods folder.
   Your folder structure should look like this: .../7 Days To Die/Mods/POIScourge/
4. Your mod is now installed and will be active the next time you launch the game.

Note: This mod must be installed on both the Server and the Client for multiplayer to function correctly.

--- 2. CORE FEATURES ---

== Clearing & Rewards ==
When you eliminate every zombie within a Point of Interest (POI), the location is marked as "Scourged."
- A visual indicator (Victory Candle/Pumpkin) appears at the rally point or near you.
- A colored checkmark is added to your map based on the POI difficulty tier.
- You receive a notification in chat detailing your reward.

Rewards are calculated based on:
- POI Tier (Difficulty)
- Biome Difficulty (Wasteland gives more than Forest)
- Total Zombie Count

== Scourge Tokens ==
This is the new currency added by the mod.
- Your total token count is displayed at the top of your Backpack inventory screen.
- Tokens are used to purchase unique rewards from the Scourge Exchange Station.

== Infestation Beacons ==
For those seeking a greater challenge:
- Obtain an "Infestation Beacon" from the Exchange Station.
- Use it inside any POI to trigger a special "Infested" quest marker to Spawn.
- This resets the POI, increases the difficulty, and respawns all zombies.
- Clearing an Infested POI yields significantly higher token rewards (default: 2x).

--- 3. THE EXCHANGE STATION ---
The Scourge Exchange Station is a custom vending machine where you spend your hard-earned tokens.

How to get it:
- Craft it at in your inventory using basic resources.
- Buy it directly from any Trader for a small token fee (check the dialogue options).

What it sells:
- Exclusive Bundles (Duke Coins, Skill Points)
- Infestation Beacons
- High-tier Resources (Legendary Parts, Steel)
- Vehicles & Vehicle Parts
- Medical Supplies & Buffs

--- 4. CONFIGURATION (SETTINGS.XML) ---
The mod generates a 'Settings.xml' file in its folder the first time you run the game. You can edit this file to customize the balance and visuals.

IMPORTANT: Restart the game after editing this file.

== Economy & Rewards ==
- TierMultiplier: Multiplies the base token reward for POI difficulty (default: 1.0).
- UseBiomeScaling: Enables/Disables extra tokens for harder biomes (default: true).
- BiomeBonus[Type]: Configures the exact bonus for each biome (Pine, Burnt, Desert, Snow, Wasteland).
- ZombieRewardDivisor: Determines how many zombies equal 1 token (default: 20). Lower = More Rewards.
- InfestedMultiplier: Multiplier for completing Infested quests (default: 2.0).
- GlobalPriceMultiplier: Adjusts all prices in the Exchange Station (default: 1.0).

== Visual Customization ==
- PlaceVictoryCandle: Toggles the physical pumpkin/candle placement on victory (true/false).
- ShowMapMarkers: Toggles the colored checkmark on the map (true/false).
- ShowChatMessages: Toggles the chat notification when earning tokens (true/false).

== Map Marker Colors ==
You can change the hex color codes for each POI Tier (0-5) to match your map preference.
Example: <ColorTier5>#FFA500</ColorTier5> (Orange)

== Gameplay Mechanics ==
- SleeperWakeTimer: If you are stuck looking for the last few zombies in a large POI, the mod will force-wake them after this many seconds (default: 60).

--- 5. CONSOLE COMMANDS ---
Open the console by pressing F1.

- psc_info
  Shows the status of the current POI (Total Volumes, Active Volumes, Living Zombies). Useful if you think a POI is bugged.

- psc_addtokens <amount>
  Cheat command to instantly add Scourge Tokens to your inventory.
  Example: psc_addtokens 100

- poiscourgecomplete (Alias: psc)
  Force-completes the current POI logic, granting rewards and marking it as cleared. Use this if a zombie falls through the world.

Change Log:  V1.1 Scourge Tokens can only display 1 decimal place(was displaying up to 6 decimals), can no longer sell items at Scourge Exchange Station, attempted to improve localization for other languages (thanks to Alvik777), Book of knowledge is only usable in hotbar and cannot be used multiple times

Change Log: V1.2 
1. Language Localization improvements for 3 initial POI Scourge Quests. Thanks again Alvik777
2. Tier 0 cleared status is saved/loaded properly when exiting/entering the game
3. When using Infestation beacon on cleared POI,  properly removes the clear flag, and gives token rewards once infestation is cleared.  
4. New map marker when clearing a POI with Infestation beacon. 
5. Map now contains 'POI Scourge Progress' information.  Including number of cleared POI's per tier 1-5 and total on the map.  Thank Frantic_Dan for influencing me into this change
6. updated settings.xml for new options

